/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package genomemap.worker;

/**
 * @author Susanta Tewari
 * @version 1.0
 * @created 08-Nov-2007 7:08:51 PM
 */
public interface Annealable {

    /** Field description */
    public static final int ANNEAL_CRITERION_GLHOOD = 0;

    /** Field description */
    public static final int ANNEAL_CRITERION_PHOOD = 1;

    /** Field description */
    public static final int ANNEAL_CRITERION_JHOOD = 2;

    /**
     * Using Hamming Distance
     */
    public static final int ANNEAL_CRITERION_HAM_DIST = 3;

    /**
     * computes the function which is used for simulated annealing
     * @return
     */
    public double compute();

    /**
     *
     * @return the initial value
     */
    public double initialValue();

    /**
     * returns the order (1- based) that will be used for annealing
     * @return
     */
    public int[] getOrder();

    /**
     * sets and order to the anneable
     *
     * @param order
     */
    public void setOrder(int[] order);
}
